Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Match goreleaser version #1009

Merged
merged 3 commits into from
Sep 23, 2024
Merged

ci: Match goreleaser version #1009

merged 3 commits into from
Sep 23, 2024

Conversation

klauspost
Copy link
Owner

@klauspost klauspost commented Sep 23, 2024

Summary by CodeRabbit

  • Chores
    • Updated the goreleaser tool version in the GitHub Actions workflows to improve performance and compatibility.
    • Modified command-line arguments to enhance the release process and manage the distribution directory more effectively.
    • Introduced a new versioning format and a pre-execution hook in the configuration file for better operational control.

Copy link

coderabbitai bot commented Sep 23, 2024

Warning

Rate limit exceeded

@klauspost has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 43 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 9b4636a and b735479.

Walkthrough

Walkthrough

The pull request includes updates to the GitHub Actions workflows for Go projects, specifically changing the version of the goreleaser tool from v1.20.0 to v2.3.2. This update is reflected in both the .github/workflows/go.yml and the .github/workflows/release.yml files. Additionally, the command-line argument --rm-dist has been replaced with --clean in both workflow files. The .goreleaser.yml file has also been modified to introduce a new versioning format and a pre-execution hook.

Changes

File Change Summary
.github/workflows/go.yml Updated goreleaser version from v1.20.0 to v2.3.2; replaced --rm-dist with --clean.
.github/workflows/release.yml Updated goreleaser version to v2.3.2; replaced --rm-dist with --clean.
.goreleaser.yml Added version declaration version: 2; introduced pre-execution hook before: hooks: - ./gen.sh.

Possibly related PRs

  • ci: Upgrade Go & other #1008: The changes in .github/workflows/release.yml regarding the goreleaser version update to 2.3.2 directly relate to the main PR's update of the same version in the .github/workflows/go.yml file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (1)
.github/workflows/go.yml (1)

94-97: Summary of goreleaser updates

The changes in this file update the goreleaser version from v1.20.0 to v2.3.2 and replace the --rm-dist flag with --clean. These updates are consistent with the PR objective to "Match goreleaser version".

Consider the following recommendations:

  1. Update your project's documentation to reflect the new goreleaser version being used.
  2. Review the goreleaser changelog for any new features or breaking changes that might benefit or affect your project: https://github.com/goreleaser/goreleaser/releases
  3. If you have any local scripts or documentation referencing goreleaser, make sure to update them to use the new version and flag.
  4. Consider pinning the goreleaser version in your project's configuration file (if applicable) to ensure consistency across different environments.
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6c5a195 and cacab98.

Files selected for processing (2)
  • .github/workflows/go.yml (1 hunks)
  • .github/workflows/release.yml (1 hunks)
Additional comments not posted (2)
.github/workflows/release.yml (1)

30-30: Approve change, but verify GoReleaser version compatibility

The change from --rm-dist to --clean appears to be correct for matching the GoReleaser version. This aligns with the PR objective.

Let's verify if this change is consistent with the GoReleaser version being used (2.3.2):

Please review the output of these commands to ensure that the --clean flag is the correct usage for GoReleaser version 2.3.2, and that --rm-dist is no longer recommended.

.github/workflows/go.yml (1)

97-97: Approve goreleaser version update and flag change with behavior verification.

The goreleaser version has been updated from v1.20.0 to v2.3.2, consistent with the previous change. Additionally, the --rm-dist flag has been replaced with --clean.

Please verify that the --clean flag behaves the same way as the old --rm-dist flag and check if there are any other flag changes that need to be made. You can run the following command to test the snapshot creation with the new flag:

Also, check the goreleaser documentation for any other changes in the CLI interface that might affect your workflow:

.github/workflows/go.yml Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (2)
.goreleaser.yml (2)

Line range hint 7-85: LGTM! Consider unifying modfile usage for consistency.

The build configurations for "s2c", "s2d", and "s2sx" are well-structured and cover a wide range of platforms and architectures. The use of -trimpath and CGO_ENABLED=0 is commendable for creating reproducible and static binaries.

For consistency, consider using a modfile for all builds or removing it from the "s2sx" build. If there's a specific reason for "s2sx" to use a different modfile, it might be helpful to add a comment explaining why.


Line range hint 87-127: LGTM! Consider expanding changelog filters.

The configuration for archives, checksums, snapshots, changelogs, and package formats is comprehensive and well-structured. The NFPM configuration is particularly useful for Linux distribution.

Consider expanding the changelog filters to exclude more non-functional changes. For example:

changelog:
  sort: asc
  filters:
    exclude:
    - '^doc:'
    - '^docs:'
    - '^test:'
    - '^tests:'
    - '^Update\sREADME.md'
    - '^ci:'
    - '^chore:'
    - '^\s*Merge\s+pull\s+request\s+'

This will further refine the changelog to focus on functional changes.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cacab98 and 9b4636a.

Files selected for processing (1)
  • .goreleaser.yml (1 hunks)
Additional comments not posted (2)
.goreleaser.yml (2)

Line range hint 1-127: Summary: GoReleaser configuration successfully updated

The changes to .goreleaser.yml successfully update the configuration to work with the latest version of GoReleaser. Key improvements include:

  1. Adding version declaration (version: 2)
  2. Introducing a pre-execution hook (./gen.sh)
  3. Maintaining comprehensive build configurations for multiple binaries
  4. Retaining well-structured archive, checksum, snapshot, and package configurations

These updates should streamline the release process and ensure compatibility with the latest GoReleaser features.

To ensure full compatibility, please run the following command to verify the configuration:

#!/bin/bash
# Description: Verify the GoReleaser configuration

# Test: Check if goreleaser can parse the configuration without errors
goreleaser check

This will validate that the updated configuration is correctly formatted and compatible with the installed GoReleaser version.


1-5: LGTM! Verify the gen.sh script.

The addition of the version declaration and pre-execution hook looks good. This update aligns the configuration with GoReleaser's latest format and introduces a preparation step before the release process.

Please ensure that the gen.sh script exists and has the correct permissions. Run the following script to verify:

Verification successful

Verified: gen.sh script exists and is executable.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and permissions of gen.sh

# Test: Check if gen.sh exists and is executable
if [ -x "./gen.sh" ]; then
    echo "gen.sh exists and is executable"
else
    echo "Error: gen.sh is missing or not executable"
    ls -l ./gen.sh
fi

Length of output: 314


Script:

#!/bin/bash
# Description: Verify the existence and permissions of gen.sh

# Test: Check if gen.sh exists and is executable
if [ -f "./gen.sh" ]; then
    if [ -x "./gen.sh" ]; then
        echo "gen.sh exists and is executable"
    else
        echo "Error: gen.sh exists but is not executable"
        ls -l ./gen.sh
    fi
else
    echo "Error: gen.sh does not exist"
fi

Length of output: 116

@klauspost klauspost merged commit 13a1ce6 into master Sep 23, 2024
19 checks passed
@klauspost klauspost deleted the ci-goreleaser branch September 23, 2024 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant